Overview of Qrvey API

Qrvey provides a comprehensive set of REST APIs that can be accessed via standard HTTP requests and responses (GET, POST, etc.). You may use the Qrvey API to work with any of the core Qrvey platform features for data collection, automation, and analytics, or when integrating Qrvey into your own applications. For best results programming with Qrvey APIs, you should be familiar with performing the same tasks in the Qrvey Admin Center and/or Qrvey Composer applications.

Before using the Qrvey API, gather the following:

• The base URL of your instance of the Qrvey platform.
• Your unique API key. All Qrvey API requests require an API key. It was provided in the welcome email that your organization received when your Qrvey instance was created. To obtain a new API key, contact your Qrvey account representative.

Note: Never expose your organization’s base URL or API Key to external users in Production environments. Instead, use secure tokens to encrypt the base URL and API Key. For more information, see Generating Security Tokens.

Qrvey API Tutorials

The Qrvey Partner Portal contains a variety of tutorials for working with the Qrvey API.

• If you are new to the Qrvey platform, see Qrvey API Tutorial.
• To view the list of current tutorials, expand Qrvey API Tutorials in the navigation tree on the left.
• For information specific to Content Deployment, see the following tutorials in the Qrvey Admin Center User Guide:
  • Automated Content Deployment (Commingled)
  • Automated Content Deployment (Segregated)

Qrvey API Reference

For information on the specific endpoints, see the Qrvey API Reference Guide (Stoplight)